Vcenter Vcha Cluster UndeploySpec

Vcenter Vcha Cluster UndeploySpec
Vcenter Vcha Cluster UndeploySpec

The Vcenter Vcha Cluster UndeploySpec schema contains the undeploy specification for a VCHA cluster.

This schema was added in vSphere API 6.7.1.

JSON Example
{
    "vc_spec": {
        "active_location": {
            "hostname": "string",
            "port": 0,
            "ssl_thumbprint": "string",
            "ssl_certificate": "string",
            "username": "string",
            "password": "string"
        }
    },
    "force_delete": false,
    "vms": {
        "passive": {
            "vm": "string",
            "bios_uuid": "string"
        },
        "witness": {
            "vm": "string",
            "bios_uuid": "string"
        }
    }
}
vc_spec
Optional

Contains the active node's management vCenter server credentials.

This property was added in vSphere API 6.7.1.

If missing or null, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance.

boolean
force_delete
Optional

Flag controlling in what circumstances the virtual machines will be deleted. For this flag to take effect, the VCHA cluster should have been successfully configured using automatic deployment.

  • If true, the Vcenter Vcha Cluster UndeploySpec.vms property will be ignored, the VCHA cluster specific information is removed, and the passive and witness virtual machines will be deleted.
  • If false, the Vcenter Vcha Cluster UndeploySpec.vms property contains the information identifying the passive and witness virtual machines.
 -  If the *Vcenter Vcha Cluster UndeploySpec.vms* property is set, then it will be validated prior to deleting the passive and witness virtual machines and VCHA cluster specific information is removed.
 -  If the *Vcenter Vcha Cluster UndeploySpec.vms* property is missing or `null`, then the passive and witness virtual machines will not be deleted. The customer should delete them in order to cleanup completely. VCHA cluster specific information is removed.

This property was added in vSphere API 6.7.1.

If missing or null, the Vcenter Vcha Cluster UndeploySpec.vms property contains the information identifying the passive and witness virtual machines.

  • If the Vcenter Vcha Cluster UndeploySpec.vms property is set, then it will be validated prior to deleting the passive and witness virtual machines. VCHA cluster specific information is removed.
  • If the Vcenter Vcha Cluster UndeploySpec.vms property is missing or null, then the passive and witness virtual machines will not be deleted. The customer should delete them in order to cleanup completely. VCHA cluster specific information is removed.
vms
Optional

Contains virtual machine information for the passive and witness virtual machines. For this flag to take effect, the VCHA cluster should have been successfully configured using automatic deployment.

If set, the Vcenter Vcha Cluster UndeploySpec.force_delete property controls whether this information is validated.

  • If the Vcenter Vcha Cluster UndeploySpec.force_delete property is true, then this information is ignored, VCHA cluster specific information is removed and the passive and witness virtual machines will be deleted.
  • If the Vcenter Vcha Cluster UndeploySpec.force_delete property is missing or null or false, then this information is validated prior to deleting the passive and witness virtual machines. VCHA cluster specific information is removed.

This property was added in vSphere API 6.7.1.

If missing or null, the Vcenter Vcha Cluster UndeploySpec.force_delete property controls the deletion of the passive and witness virtual machines.

  • If the Vcenter Vcha Cluster UndeploySpec.force_delete property is true, then the passive and witness virtual machines will be deleted. VCHA cluster specific information is removed.
  • If the Vcenter Vcha Cluster UndeploySpec.force_delete property is missing or null or false, then the passive and witness virtual machines will not be deleted. The customer should delete them in order to cleanup completely. VCHA cluster specific information is removed.
Parameter To